home *** CD-ROM | disk | FTP | other *** search
/ Space & Astronomy / Space and Astronomy (October 1993).iso / pc / mac / _dehqx_folder / dehqx_documentation < prev   
Text File  |  1991-08-23  |  14KB  |  249 lines

  1. DeHQX v2.0.0 ⌐ Peter Lewis, Aug 1991.
  2. This program is Freeware, and the THINK Pascal source code is available from various FTP sites.
  3.  
  4. Ñ Contents
  5.  
  6.       What DeHQX Does
  7.       Definitions
  8.       Using DeHQX
  9.       Features
  10.       Preferences
  11.       How It Works
  12.       Limitations
  13.       Small Print
  14.       Warranty
  15.       Fine Print
  16.       Version History
  17.       Acknowledgements
  18.       The Author
  19.  
  20. Ñ What DeHQX Does
  21.  
  22.       DeHQX restores files that have been hqxed by a BinHex 4.0 compatible program.  The BinHex format stores Macintosh files (including some Finder information as well as the data and resource forks) in a text-only form that can be transmitted between computers without fear of lost bits (especially the high bits).
  23.  
  24. Ñ Definitions
  25.  
  26. Output file: a file decoded from BinHex format that is created by DeHQX.
  27. HQX Source: the BinHex representation of one output file.
  28. Source file: a file containing (parts of) one or more HQX sources.
  29. DeHQX: a noun, the program described in this documentation.
  30. Dehqx: a verb meaning to restore a file stored in BinHex format.  Hence dehqxing.  (I pronounce dehqx as if it was spelt dee-hecks.)
  31.  
  32. Ñ Using DeHQX
  33.  
  34.       - Launch DeHQX from the Finder.
  35.       - Set the options via the Preferences item of the File menu.
  36.       - Choose DeHQX╔ from the File menu.
  37.       - Select a file or folder.
  38.       - If prompted, select an output file name and folder.
  39.       - If an error is detected, you may choose whether to delete the file  that was being created, as well as whether to continue dehqxing files.  Note: The file being created will almost certainly be useless, and choosing a continue option will not continue with this file, only with other files in the folder (or other hqx sources in the same source file).
  40.  
  41. Ñ Features
  42.  
  43.       - Dehqxes individual files or entire folders.
  44.       - Source files may contain multiple separate HQX sources.
  45.       - Source files may contain any NEWS or MAIL headers.
  46.       - HQX sources may contain part separators (ie, "--- end of part 1").
  47.       - HQX parts may be split across multiple (alphabetical) files.
  48.       - Optionally dehqxes a pre-specified folder on startup.
  49.       - Optionally produces a folder for the output files.
  50.       - Optionally prompts for the output file only if it already exists, or automatically creates a unique name, skips the file, or overwrites the file.
  51.       - Dehqx Any files, TEXT files, or TEXT files that end in "hqx".
  52.       - Optionally delete the source file (if there are no errors).
  53.       - Optionally beep or flash the apple/application menu on completion.
  54.       - Calculates and verifies the checksums (CRC).
  55.       - MultiFinder and System 7 friendly.
  56.       - Works well in the background.
  57.       - Almost totally non-modal.
  58.  
  59. Ñ Preferences
  60.  
  61.       When DeHQX is launched, it checks the Preferences folder in the System Folder for the DeHQX Preferences document.  If it finds the document, it reads the preferences from there.  You can change the settings by choosing Preferences from the File menu.  If you click the OK button, changes you make will be temporary, while clicking the Save button makes the changes permanent.  You can set the following options:
  62.  
  63. Prompt For File Name:
  64.     Always - Always prompt for the output name.
  65.     If destination exists - Prompt only if the output file already exists.
  66.     Skip - If destination exists, skip the file.
  67.     Overwrite file - Always overwrite the output file.
  68.     Create unique name - Generate a unique name if the file already exists.
  69.  
  70. Create DeHQXeD Folder:
  71.     Always - Always create a folder for the output files.
  72.     If dehqxing a folder - Create DeHQXeD folder if you are dehqxing a folder.
  73.     Never - Never create a new folder.
  74.  
  75. Display:
  76.     All Files - All files will be displayed in the DeHQX╔ dialog box.
  77.     TEXT Files - All TEXT files will be displayed.
  78.     .hqx TEXT Files - Only TEXT files ending in "hqx" will be displayed.
  79.  
  80.       The files that are displayed will be dehqxed if the folder button is clicked.  It doesn't really matter if there are non HQX files in the list, since they will not contain the required "(This file must be ╔", so no output file will be generated, and the file will not be deleted even if the delete option is selected (theoretically anyway. Personally, I wouldn't try this on the only copy of my honours thesis! :-).
  81.  
  82. Handle Parts - Remove section parts (see How It Works).
  83.  
  84. Demand '(This file╔' - Require this string to start the dehqxing.  Otherwise dehqx will allow dehqxing to start after a 64 character line starting with a colon and containing valid hqx characters.
  85.  
  86. On startup:
  87.     Prompt for files - Display the DeHQX╔ dialog box when DeHQX starts up.
  88.     Dehqx folder: - Dehqx the specified folder when DeHQX starts.
  89.         Click the button to set the folder, the checkbox to enable/disable it.
  90.         If you hold option down on startup, the folder will be ignored.
  91.  
  92. On completion:
  93.     Delete Source - Delete the source file after dehqxing.
  94.     Beep - DeHQX beeps when it finishes dehqxing.
  95.     Flash Apple - Flash the Apple/Application menu when finished dehqxing.
  96.     Quit - Quit DeHQX when finished dehqxing.
  97.  
  98. Ñ How It Works
  99.  
  100.       DeHQX scans the source file selected (or all the displayed files in the folder selected) for the string "(This file must be converted with BinHex 4.0)"  (if Demand 'This file╔' is not checked, DeHQX will also allow a hqx file to start with a 64 character line starting with a colon and containing only valid hqx characters).  The next character must be a colon (:).  DeHQX then begins dehqxing the file.  If it encounters a line beginning with "--- end of part", it ignores the file until it encounters a line consisting only of "---", at which time it resumes dehqxing. When it comes to the end of the HQX source, if checks for the terminating colon, and then continues scanning the file for the next "(This file╔"
  101.  
  102.       So each source file may contain multiple HQX sources, each of which may 
  103. be segmented into parts.
  104.  
  105.       After DeHQX has finished, it will delete the source files if 
  106.           - the Delete Source File option is selected.
  107.           - no errors were encountered in the source file.
  108.           - at least some (around 60) hqx characters were read from the file.
  109.  
  110. Ñ Limitations
  111.  
  112.       DeHQX probably requires the 128k ROM and system version 6.0.  It may well only work with a Mac Plus or Classic or IIsi, and System 7.0.  It appears to work with MultiFinder, System 6.0.x, System 7.0, SE/30, IIci.  It should require little memory.
  113.  
  114.       DeHQX can dehqx a HQX source if it has been split into separate files as long as the parts are ordered alphabetically.  If the parts are numbered, you must be careful that the 10th,11th,12th etc files do not come before the 2nd file (eg, BigFile-10.hqx comes before BigFile-2.hqx.  Rename the latter to BigFile-02.hqx).
  115.  
  116. Thanks to Howard, DeHQX verifies the checksum stored in the HQX sources.  If the checksum is bad, you'll get an unpleasant message about invalid HQX formats.
  117.  
  118. Ñ Small Print
  119.  
  120.       This Program is Freeware.  You may distribute it any way you wish as long as you don't charge for it.  It would probably be a good idea to keep this documentation file with the program (but I'm hardly likely to check up on you now am I!).  Remember, with Freeware you may be getting what you paid for! (I don't guarantee any support, but I always answer my Email (snail-mail with bits of paper and such I'm not so good with!))
  121.  
  122.       If you use this program, send me a note!  Curiously, over 600 people downloaded DeHQX v1.0.5, yet only a couple dozen people sent me Email!  Thank heavens I didn't make it Shareware! :-)
  123.  
  124. Ñ Warranty
  125.  
  126.       There is absolutely NO warranty, guarantee, hint, suggestion or anything else that would lead anyone to think that DeHQX does anything stated in this documentation.  It usually does not destroy data (systems, hardware, etc), and has sometimes worked on my Mac Plus with System 7.0.  It is highly unlikely that it will work with older systems (pre 6.0 anyway) or with the 64k ROM.  It might work with the SE models and the II models, but I don't have one, so I don't know.  (Anyone want to give me a IIfx so I can check for compatibility?)  If it works on your system (or especially if it doesn't!), send me a postcard or some Email and let me know!
  127.  
  128. Ñ Fine Print
  129.  
  130.       Peter Lewis hereby disclaims all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose.  Does any one really read this stuff.  Peter Lewis will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Peter Lewis or an agent of his has been advised of the possibility of such damages.  In no event shall Peter Lewis be liable for any damages, regardless of the form of the claim.  The person using the software bears all risk as to the quality and performance of the software.
  131.  
  132. Ñ Version History
  133.  
  134. Still to do:
  135. Save window rects
  136. Accumulate Header info into a file - Bob Boonstra
  137. Put source and output files into folders?
  138. Add EnHQX ability? - Bill Johnston (HeidiTools)
  139. Unattended operation? - Dan Wismer
  140. SYSTEM 7 STUFF:
  141. Call StuffIt/Compactor etc to unstuff files - Allan Burton
  142.  
  143. 2.0.0 - Release 2
  144.  
  145. 1.1.5d - Final Beta Release
  146. ~Fix crash due to missing "otherwise" in a case statement.
  147.  
  148. 1.14d - Minor Beta Release
  149. Allow start without the (This file...)
  150. If the user cancels, stop.
  151. Put file name in error alerts
  152. Always delete the trashed output files
  153. Didn't always display the Creator name instead of signiture
  154. Ensure it dehqxes the folder immediately, not after an event
  155. Disable drop folder if files are droped onto DeHQX
  156. Actually use the Drop Folder check box!
  157. Policy for ╔ in menus.  
  158.     All menus that which requires more information in order to 
  159.     complete or simply displays information have ╔
  160.  
  161. 1.1.3d - Beta Release
  162. Crash with half a .hqx file? - Craig
  163. Drop Folder that gets checked on startup
  164. Simplify Prefs (Loose Load/Save Prefs, put Save,OK,Cancel in Dialog box)
  165.     - Bill Johnston
  166. Colour Icons - Allan Burton (ARGH!  Need a mac with 256 colours! }
  167.     { ARGHH! ARRGHH! 8-bit ICONs take up 1k! }
  168. Can't drag multiple files to DeHQX
  169.     Moral: Don't dispose of the list until you have read ALL the items! :-)
  170. Cancel button
  171. Use GetGrayRgn^^.RgnBBox for dragging windows - Mike Dickens
  172. SYSTEM 7 STUFF:
  173. Put Help menu item in the Balloon Help Menu
  174.  
  175. 1.1.1d - Beta Release
  176. Move Name/Type/Creator/Data/Resource closer together
  177. Init cursor somewhere - on Resume perhaps! - John Gee
  178. Dim About/Help when window is at front
  179. cmd-. Fails AGAIN! - Neale
  180. Fix menus, add Close and handle it
  181. Fix CHK Error with some multipart files - Neale
  182.     Tricky.  It thought the second --- in "--- end of part 1 ---" was the start!
  183. Delete, Quit, Beep - doesn't beep before quiting. - John Gee
  184. Tripple-click with Auto DeHQX on, hangs with file box - John Gee
  185.     Disabled auto dehqx if DeHQX isn't in the foreground at the right time
  186. SYSTEM 7 STUFF:
  187. Replace Creator with Creator Name
  188.  
  189. 1.1.0d - Beta Release
  190. No command-A About key - Les Felch?
  191. Default to TEXT - Les Felch?
  192. Quit when Finished Option - Darko
  193. Folder Button in Save As dialog - ?
  194. Just use 1k,2k,3k,4k,5k,╔ instead of 1024,2048,3072,4k,╔ - Bill Johnston?
  195. Track Modifications of Prefs file
  196. Command-. doesnt work - Les Felch
  197. Use Notification Manager instead of beep (when I figure out how!)
  198.    - Neale Hays
  199. Fix it so that Delete on Completion works fully 
  200.    * better check if it works!
  201.    - Chris Webster & Bill Johnst on
  202. Put strings in resource fork
  203. Speed Up! - Les Felch et al
  204.    * could be more, but it could always be faster!
  205. Fix versions to use ParamText
  206. Move folder button in SF dialog boxes? - nope, inconsistent with SFPutFile.
  207. Make About & Help windows movable and non-modal
  208. Add global progress bar
  209. Allow DeHQX╔ menu item even while dehqxing
  210. SYSTEM 7 STUFF:
  211. Add small icons
  212. Add FREF's for fold,disk (and keep TEXT)
  213. Resolve alias file reference on prefs file
  214. Use Sys7 Prefs folder - Check for Gestault gestaltFindFolderPresent 
  215. Support Apple Events (when I figure out how!) - Bill Johnston
  216.  
  217. 1.0.5, Mar 1991 - Release 5.  Display "Press command-. to Cancel" in DeHQX window.  Allow files to be split anywhere.  Fixed DeHQX so that ALL version numbers are the same.  Changed option selection from a menu to a dialog box.Changed DeHQX window from a dialog box to a document window.  Split files without parts. Become much more MultiFinder friendly  (DeHQX in background, movable window, etc).
  218.  
  219. 1.04, Jan 1991 - Beta Release 4.  Allow spaces in the hqx sources.  Disable the "DeHQX at Startup" option if DeHQX was started by double-clicking hqx documents.  Added mstr=103 so multifinder will launch DeHQX when its documents are double-clicked.
  220.  
  221. 1.03b, Dec 1990 - Beta Release 3.  Calculates and verifies CRCs.  Added options to generate a unique output name, and to automatically open the DeHQX╔ dialog box on startup.
  222.  
  223. 1.02b, Dec 1990 - Beta release 2.  Saveable preferences.   Handles HQX parts separated over multiple files.  Quit now leaves the File menu highlighted. Handles launching DeHQX documents (set the creator of the file to 'PnLh').  Improved the About and Help dialog boxes (yes, they were actually worse than they are now!).
  224.  
  225. 1.01b, Oct 1990 - Beta release to six testers scattered across Australia and New Zealand.
  226.  
  227. Thanks to Neale Hays,Bill Johnston,Les Felch,Darko,Chris Webster,Bob Boonstra, and others for some of these suggestions.
  228.  
  229. Ñ Acknowledgements
  230.  
  231. Thanks go to the Howard, Paul, Allan, Tony, Chris, Martin, DRJQ, the UCC, Curtin, Todd, Steve, Neale, Bill, Les, Chris, Bob, c.s.m.p, ditmela.oz.au (& Harold), (ftp.)apple.com, Stephen, and anyone who uses DeHQX!
  232.  
  233. Ñ The Author
  234.  
  235.       Send postcards, comments, bug reports, wishes and $5 donations to:
  236.  
  237. Peter Lewis,
  238. 10 Earlston Way,
  239. Booragoon, WA, 6154,
  240. AUSTRALIA
  241.  
  242. or, better yet, by electronic mail to:
  243.  
  244. Internet: Lewis_P@cc.curtin.edu.au
  245. Bitnet: Lewis_P%cc.curtin.edu.au@cunyvm.bitnet
  246. UUCP: uunet!munnari.oz!cc.curtin.edu.au!Lewis_P
  247.  
  248. If you use DeHQX, please send me a note!
  249.